3.6 修改本地组织架构(支持增量修改)
请求参数
Path: /api/v2/localUserGroup/updateGroup
Method: POST
接口描述:
- 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改
- 认证策略ID,authComposeId获取方式,用“开发者工具”过滤请求 authCompose/queryAll,在控制台“业务管理”->“认证管理”->“认证策略”页面中打开您新增用户所属的用户目录,找到所属用户目录的认证策略查询接口,查看响应体数据获取对应的认证策略ID
- 用户策略ID,userPolicyId获取方式,用“开发者工具”过滤请求 userPolicy/queryUserPolicy,进入控制台“业务管理”->“策略管理”->“用户策略”页面,查看响应体数据获取所需策略的ID
- 根据id更新时,支持修改组织架构名;根据name更新时,不支持修改组织架构名。
请求参数
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 必须 |
Body
根据name更新
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
name | string | 必须 | 组织架构名字 | ||
parentGroupId | string | 必须 | 所属组ID,和path二选一,都传时以parentGroupId为主 | ||
path | string | 必须 | 所属组名,和parentGroupId二选一,都传时以parentGroupId为主 | >=2.2.16 开始支持 | |
description | string | 非必须 | 组织架构描述 | ||
resourceIdEditWay | string | 非必须 | 'set' | 应用编辑方式,'set'重置,'append'追加,'delete'删除 | 应用编辑方式只能是重置、追加、删除 |
resourceIdList | string[] | 非必须 | 应用ID列表 | resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准 | |
resourceNameList | string[] | 非必须 | 应用名列表 | resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准 | |
resourceGroupIdEditWay | string | 非必须 | 应用分类编辑方式,'set'重置,'append'追加,'delete'删除 | 应用分类编辑方式只能是重置、追加、删除 | |
resourceGroupIdList | string[] | 非必须 | 应用分类ID列表 | resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准 | |
resourceGroupNameList | string[] | 非必须 | 应用分类名列表 | resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准 | |
roleIdEditWay | string | 非必须 | 'set' | 角色编辑方式,'set'重置,'append'追加,'delete'删除 | |
roleIdList | string[] | 非必须 | 角色ID列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
roleNameList | string[] | 非必须 | 角色名列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
authComposeId | string | 非必须 | 认证策略ID | 2.2.5开始支持,可以传空字符串代表策略为空 | |
userPolicyId | string | 非必须 | 用户策略ID | 2.2.5开始支持,可以传空字符串代表策略为空 |
根据id更新
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
id | string | 必须 | 组织架构ID | ||
name | string | 非必须 | 组织架构名字 | ||
parentGroupId | string | 非必须 | 所属组ID,和path二选一,都传时以parentGroupId为主 | ||
path | string | 非必须 | 所属组名,和parentGroupId二选一,都传时以parentGroupId为主 | >=2.2.16 开始支持 | |
description | string | 非必须 | 组织架构描述 | ||
resourceIdEditWay | string | 非必须 | 应用编辑方式,'set'重置,'append'追加,'delete'删除 | 应用编辑方式只能是重置、追加、删除 | |
resourceIdList | string[] | 非必须 | 应用ID列表 | resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准 | |
resourceNameList | string[] | 非必须 | 应用名列表 | resourceIdList和resourceNameList只传一个即可,都传时以resourceIdList为准 | |
resourceGroupIdEditWay | string | 非必须 | 应用分类编辑方式,'set'重置,'append'追加,'delete'删除 | 应用分类编辑方式只能是重置、追加、删除 | |
resourceGroupIdList | string[] | 非必须 | 应用分类ID列表 | resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准 | |
resourceGroupNameList | string[] | 非必须 | 应用分类名列表 | resourceGroupIdList和resourceGroupNameList只传一个即可,都传时以resourceGroupIdList为准 | |
roleIdEditWay | string | 非必须 | 'set' | 角色编辑方式,'set'重置,'append'追加,'delete'删除 | |
roleIdList | string[] | 非必须 | 角色ID列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
roleNameList | string[] | 非必须 | 角色名列表 | roleIdList和roleNameList只传一个即可,都传时以roleIdList为准 | |
authComposeId | string | 非必须 | 认证策略ID | 2.2.5开始支持,可以传空字符串代表策略为空 | |
userPolicyId | string | 非必须 | 用户策略ID | 2.2.5开始支持,可以传空字符串代表策略为空 |
请求示例
{
"name": "本地分组1",
"path": "/",
"description": "",
"resourceIdEditWay": "set",
"resourceIdList": ["0e8cec60-5585-11eb-9aa3-27b058cac48b", "c4f643f0-5717-11eb-b6e0-f7651d8dccc0"],
"resourceGroupIdList": [],
"roleIdEditWay": "append",
"roleIdList": [ "7759f620-5583-11eb-880a-913383f106f2", "6559f620-5583-11eb-880a-913383f106f2"],
}
返回数据
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
code | number | 必须 | 错误码,非0表示错误,具体含义请参考错误码定义 | ||
data | number | 必须 | 修改的组织架构数 | ||
msg | string | 必须 | 描述信息 |
返回示例
{
"code": 0,
"data": 1,
"msg": "请求成功"
}
错误信息
错误提示 | 错误码 |
---|---|
本地组织架构不存在 | 7201 |
本地组织架构不存在 | 77200001 |
parentGroupId和path参数至少需要传一个 | 7201 |
请输入id或name | 7201 |
参数检查出错 | 10000001 |
名称不能为空 | 10000001 |
用户或用户组织架构最多关联1000个应用 | 10000000 |
用户组织架构不存在 | 77200005 |
不能将父组设置为自己及自己的子组 | 77200004 |
所属组不存在 | 77200005 |
用户组织架构名(%s)已存在 | 77200005 |
保存失败,授权的应用不存在 | 77200004 |
保存失败,授权的应用分类不存在 | 77200004 |
部分角色数据已经删除,请重新选择 | 10000001 |
认证策略不存在 | 77200004 |
用户策略不存在 | 77200004 |
本地组织架构长度不允许超过(512)字符 | 10000001 |
操作失败 | 10000000 |